home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / tarmail / README < prev    next >
Text File  |  1994-08-01  |  3KB  |  79 lines

  1.  
  2.                toolbox/public/tarmail README
  3.  
  4.      This directory contains tarmail, a utility for sending files
  5.      through e-mail.  This is a convenient way to mail files and/or
  6.      entire directories of files.  The files can be either text
  7.      or binaries.  This software is public domain, and can be
  8.      distributed and/or modified freely as long as the authors
  9.      names are not removed.
  10.  
  11.      To compile and install tarmail, copy this directory to a local disk,
  12.      and type:
  13.  
  14.           su
  15.           make install
  16.  
  17.      This will install the following files into your /usr/local/bin
  18.      directory:
  19.  
  20.           atob
  21.           btoa
  22.           tarmail
  23.           untarmail
  24.           viewtarmail
  25.  
  26.      To use tarmail, the above files must be installed on both
  27.      the sending and receiving machines (and remember to add
  28.      /usr/local/bin to your path).
  29.  
  30.      To give tarmail to someone else so that they may install it,
  31.      simply send them (through normal e-mail) the entire "tarmail.kit"
  32.      file, without modification.  This file includes everything needed
  33.      to install tarmail, along with instructions on how to do it.
  34.  
  35.  
  36.      -------------------------------------------------------------
  37.  
  38.  
  39.      Usage is as follows:
  40.  
  41.           tarmail [-s subject] person files ...
  42.           
  43.                Will send the listed files and/or directories to
  44.                the specified person, with an optional subject
  45.                heading.
  46.  
  47.           untarmail file, or
  48.           untarmail -
  49.  
  50.                Will extract the enclosed files/directories from
  51.                a file containing the received mail message.  Note
  52.                that the headers need not be removed from the mail
  53.                message -- untarmail will automatically extract
  54.                the proper data.  As with tar, the files/directories
  55.                will be placed in the current working directory,
  56.                unless the names are absolute paths.  The "-" option
  57.                can be used to read a list from standard input
  58.                (typically used with a pipe).
  59.  
  60.           viewtarmail file, or
  61.           viewtarmail -
  62.           
  63.                Will print a listing of the enclosed files/directories
  64.                from a file containing the received mail message.  The
  65.                "-" option can be used to read a list from standard input.
  66.  
  67.  
  68.      NOTE:  For alternate mailers, you may need to modify the "tarmail"
  69.             script a bit to get it to work properly -- as written,
  70.             it assumes a Berkeley "Mail" that supports the "-s subject"
  71.             option and the "~:" subcommand (so that you can suppress
  72.             adding tarmail'd files to your mail filecopy). If all else
  73.             fails, just use this for "tarmail":
  74.  
  75.                  #!/bin/sh
  76.                  who="$1"; shift
  77.                  tar cvf - $* | compress | btoa | mail $who
  78.  
  79.